Skip to content

Replace <font> in user docs with <span style>#696

Merged
yamgent merged 1 commit into
MarkBind:masterfrom
Xenonym:docs/remove-font-tag
Mar 11, 2019
Merged

Replace <font> in user docs with <span style>#696
yamgent merged 1 commit into
MarkBind:masterfrom
Xenonym:docs/remove-font-tag

Conversation

@Xenonym

@Xenonym Xenonym commented Feb 16, 2019

Copy link
Copy Markdown
Contributor

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] Documentation update

As suggested in #680 (review).

What is the rationale for this request?
The <font> HTML tag is deprecated and should not be used in our documentation.

What changes did you make? (Give an overview)
I replaced uses of <font color="[colour]"> in our documentation with <span style="color: [colour]">.

Is there anything you'd like reviewers to focus on?
Note that the SVG files for FA icons use a <font> tag as well. While the SVG <font> tag is also deprecated, we probably shouldn't arbitrarily modify upstream assets unless necessary.

yamgent
yamgent previously approved these changes Feb 17, 2019

@yamgent yamgent left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like this PR was forgotten, sorry about that!

Propose a merge commit message. This one should be relatively simple to write (talk about font becoming obsolete with citation to the Mozilla standard, then mention replacing font with span+style equivalent substitute).

@Xenonym

Xenonym commented Mar 11, 2019

Copy link
Copy Markdown
Contributor Author

Proposed commit message:

Replace <font> in user docs with <span style>

There are multiple instances in our user docs where we use <font>
to inline style text. However, <font> has been deprecated [1] and
should not be used in our user docs.

Let's replace uses of <font> with <span style> instead to inline style
text in our user docs.

[1]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/font#Summary

@yamgent yamgent added this to the v1.20.1 milestone Mar 11, 2019
@yamgent

yamgent commented Mar 11, 2019

Copy link
Copy Markdown
Member

Nice 👍.

@yamgent yamgent changed the title Replace <font> in docs with <span> Replace <font> in user docs with <span style> Mar 11, 2019
@yamgent yamgent merged commit d6899fd into MarkBind:master Mar 11, 2019
@Xenonym Xenonym deleted the docs/remove-font-tag branch March 11, 2019 08:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants